home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / xgraph.man < prev    next >
Text File  |  1991-11-01  |  13KB  |  397 lines
  1.  
  2.  
  3.  
  4. XGRAPH                    User Commands                    XGRAPH
  5.  
  6.  
  7.  
  8. NNAAMMEE
  9.      xgraph - Draw a graph on an X11 Display
  10.  
  11. SSYYNNOOPPSSIISS
  12.      xxggrraapphh [ options ] [ =WxH+X+Y ] [ -display
  13.      host:display.screen ] [ file ... ]
  14.  
  15. DDEESSCCRRIIPPTTIIOONN
  16.      The _x_g_r_a_p_h program draws a graph on an X display given data
  17.      read from either data files or from standard input if no
  18.      files are specified.  It can display up to 64 independent
  19.      data sets using different colors and/or line styles for each
  20.      set.  It annotates the graph with a title,  axis labels,
  21.      grid lines or tick marks, grid labels, and a legend.  There
  22.      are options to control the appearance of most components of
  23.      the graph.
  24.  
  25.      The input format is similar to _g_r_a_p_h(_1_G) but differs
  26.      slightly.  The data consists of a number of _d_a_t_a _s_e_t_s. Data
  27.      sets are separated by a blank line.  A new data set is also
  28.      assumed at the start of each input file.  A data set con-
  29.      sists of an ordered list of points of the form "X Y".  Each
  30.      point must appear on a separate line. The name of a data set
  31.      can be specified by a line which begins with a double quote
  32.      followed by the set name.  An example input file with three
  33.      data sets is shown below (note set three is not named):
  34.  
  35.      0.5 7.8
  36.      1.0 6.2
  37.      "set one
  38.      1.5 8.9
  39.  
  40.      "set two
  41.      -3.4 1.4e-3
  42.      -2.0 1.9e-2
  43.      -0.65 2.2e-4
  44.  
  45.      2.2 12.8
  46.      2.4 -3.3
  47.      2.6 -32.2
  48.      2.8 -10.3
  49.  
  50.      After _x_g_r_a_p_h has read the data,  it will create a new window
  51.      to graphically display the data.  The interface used to
  52.      specify the size and location of this window depends on the
  53.      window manager currently in use.  Refer to the reference
  54.      manual of the window manager for details.
  55.  
  56.      Once the window has been opened,  all of the data sets will
  57.      be displayed graphically (subject to the options explained
  58.      below) with a legend in the upper right corner of the
  59.      screen.  To zoom in on a portion of the graph,  depress a
  60.  
  61.  
  62.  
  63. Sprite v1.0             February 1, 1989                        1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XGRAPH                    User Commands                    XGRAPH
  71.  
  72.  
  73.  
  74.      mouse button in the window and sweep out a region.  _x_g_r_a_p_h
  75.      will then open a new window looking at just that portion of
  76.      the graph.  _x_g_r_a_p_h also presents two control buttons in the
  77.      upper left corner of each window: _C_l_o_s_e and _H_a_r_d_c_o_p_y. Win-
  78.      dows are closed by depressing a mouse button while the mouse
  79.      cursor is inside the _C_l_o_s_e button.  Typing EOF (control-D)
  80.      in a window also closes that window.  Depressing a mouse
  81.      button while the mouse cursor is in the _H_a_r_c_o_p_y button
  82.      causes a dialog to appear asking about hardcopy (printout)
  83.      options.  These options are described below:
  84.  
  85.      Output Device
  86.           Specifies the type of the output device (e.g. "HPGL",
  87.           "Postscript", etc).  An output device is chosen by
  88.           depressing the mouse inside its name.  The default
  89.           values of other fields will change when you select a
  90.           different output device.
  91.  
  92.      Disposition
  93.           Specifies whether the output should go directly to a
  94.           device or to a file.  Again,  the default values of
  95.           other fields will change when you select a different
  96.           disposition.
  97.  
  98.      File or Device Name
  99.           If the disposition is "To Device",  this field speci-
  100.           fies the device name.  A device name is the same as the
  101.           name given for the -P command of lpr(1).  If the dispo-
  102.           sition is "To File",  this field specifies the name of
  103.           the output file.
  104.  
  105.      Maximum Dimension
  106.           This specifies the maximum size of the plot on the
  107.           hardcopy device in centimeters.  _x_g_r_a_p_h takes in
  108.           account the aspect ratio of the plot on the screen and
  109.           will scale the plot so that the longer side of the plot
  110.           is no more than the value of this parameter.  If the
  111.           device supports it,  the plot may also be rotated on
  112.           the page based on the value of the maximum dimension.
  113.  
  114.      Title Font Family
  115.           This field specifies the name of a font to use when
  116.           drawing the graph title.  Suitable defaults are ini-
  117.           tially chosen for any given hardcopy device.  The value
  118.           of this field is hardware specific -- refer to the dev-
  119.           ice reference manual for details.
  120.  
  121.      Title Font Size
  122.           This field specifies the desired size of the title
  123.           fonts in points (1/72 of an inch). If the device sup-
  124.           ports scalable fonts,  the font will be scaled to this
  125.           size.
  126.  
  127.  
  128.  
  129. Sprite v1.0             February 1, 1989                        2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XGRAPH                    User Commands                    XGRAPH
  137.  
  138.  
  139.  
  140.      Axis Font Family and Axis Font Size
  141.           These fields are like _T_i_t_l_e _F_o_n_t _F_a_m_i_l_y and _T_i_t_l_e _F_o_n_t
  142.           _S_i_z_e except they specify values for the font _x_g_r_a_p_h
  143.           uses to draw axis labels, and legend descriptions.
  144.  
  145.      Control Buttons
  146.           After specifing the parameters for the plot,  the "Ok"
  147.           button causes _x_g_r_a_p_h to produce a hardcopy.  Pressing
  148.           the "Cancel" button will abort the hardcopy operation.
  149.  
  150.      _x_g_r_a_p_h accepts a large number of options most of which can
  151.      be specified either on the command line or in the user's
  152.      ~/.Xdefaults file.  A list of these options is given below.
  153.      The command line option is specified first with its X
  154.      default name (if any) in parenthesis afterward.  The format
  155.      of the option in the X defaults file is "program.option:
  156.      value" where program is the program name (xgraph) and the
  157.      option name is the one specified below.  Note that the value
  158.      of a flag in the X defaults file must be "1".
  159.  
  160.      --<<ddiiggiitt>> <<nnaammee>>
  161.           These options specify the data set name for the
  162.           corresponding data set.  The digit should be in the
  163.           range '0' to '63'.  This name will be used in the
  164.           legend.
  165.  
  166.      --bb   Force _x_g_r_a_p_h to output the graph in black and white
  167.           (even if the display is color).  This is useful for
  168.           those using _x_w_d(_1) to produce hardcopies of the graph.
  169.  
  170.      --bbaarr Specifies that vertical bars should be drawn from the
  171.           data points to a base point which can be specified with
  172.           -brb.  Usually,  the -nl flag is used with this option.
  173.           The point itself is located at the center of the bar.
  174.  
  175.      --bbbb ((BBoouunnddBBooxx))
  176.           Draw a bounding box around the data region.  This is
  177.           very useful if you prefer to see tick marks rather than
  178.           grid lines (see -tk).
  179.  
  180.      --bbdd <<ccoolloorr>> ((BBoorrddeerr))
  181.           This specifies the border color of the _x_g_r_a_p_h window.
  182.  
  183.      --bbgg <<ccoolloorr>> ((BBaacckkggrroouunndd))
  184.           Background color of the _x_g_r_a_p_h window.
  185.  
  186.      --bbrrbb <<bbaassee>>
  187.           This specifies the base for a bar graph.  By default,
  188.           the base is zero.
  189.  
  190.      --bbrrww <<wwiiddtthh>>
  191.           This specifies the width of bars in a bar graph.  The
  192.  
  193.  
  194.  
  195. Sprite v1.0             February 1, 1989                        3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XGRAPH                    User Commands                    XGRAPH
  203.  
  204.  
  205.  
  206.           amount is specified in the user's units.  By default,
  207.           a bar one pixel wide is drawn.
  208.  
  209.      --bbww <<ssiizzee>> ((BBoorrddeerrSSiizzee))
  210.           Border width (in pixels) of the _x_g_r_a_p_h window.
  211.  
  212.      --ffgg <<ccoolloorr>> ((FFoorreeggrroouunndd))
  213.           Foreground color.  This color is used to draw all text
  214.           and the normal grid lines in the window.
  215.  
  216.      --llff <<ffoonnttnnaammee>> ((LLaabbeellFFoonntt))
  217.           Label font.  All axis labels and grid labels are drawn
  218.           using this font.  It must be a fixed-width font.
  219.  
  220.      --llnnxx Specifies a logarithmic X axis.  Grid labels represent
  221.           powers of ten.
  222.  
  223.      --llnnyy Specifies a logarithmic Y axis.  Grid labels represent
  224.           powers of ten.
  225.  
  226.      --llww wwiiddtthh
  227.           Specifies the width of the data lines in pixels.  The
  228.           default is one.
  229.  
  230.      --llxx <<xxll,,xxhh>>
  231.           This option limits the range of the X axis to the
  232.           specified interval.  This (along with -ly) can be used
  233.           to "zoom in" on a particularly interesting portion of a
  234.           larger graph.
  235.  
  236.      --llyy <<yyll,,yyhh>>
  237.           This option limits the range of the Y axis to the
  238.           specified interval.
  239.  
  240.      --mm ((MMaarrkkeerrss))
  241.           Mark each data point with a distinctive marker.  There
  242.           are eight distinctive markers used by xgraph.  These
  243.           markers are assigned uniquely to each different line
  244.           style on black and white machines and varies with each
  245.           color on color machines.
  246.  
  247.      --MM ((SSttyylleeMMaarrkkeerrss))
  248.           Similar to -m but markers are assigned uniquely to each
  249.           eight consecutive data sets (this corresponds to each
  250.           different line style on color machines).
  251.  
  252.      --nnll ((NNooLLiinneess))
  253.           Turn off drawing lines.  When used with -m,  this can
  254.           be used to produce scatter plots.  When used with -bar,
  255.           it can be used to produce standard bar graphs.
  256.  
  257.      --pp ((PPiixxeellMMaarrkkeerrss,, SSmmaallllPPiixxeellss))
  258.  
  259.  
  260.  
  261. Sprite v1.0             February 1, 1989                        4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XGRAPH                    User Commands                    XGRAPH
  269.  
  270.  
  271.  
  272.           Marks each data point with a small marker (pixel
  273.           sized).  This is usually used with the -nl option for
  274.           scatter plots.
  275.  
  276.      --PP ((LLaarrggeePPiixxeellss))
  277.           Similar to -p but marks each pixel with a large dot.
  278.  
  279.      --rrvv ((RReevveerrsseeVViiddeeoo))
  280.           Reverse video.  On black and white displays,  this will
  281.           invert the foreground and background colors.  It does
  282.           nothing on color displays.
  283.  
  284.      --ss ((SSpplliinnee))
  285.           This option specifies the lines should be drawn as
  286.           spline curves.  Currently,  this is implemented using
  287.           the X spline option which fits only three points at a
  288.           time.  Thus,  the effect is not what you might expect.
  289.  
  290.      --tt <<ssttrriinngg>>
  291.           Title of the plot.  This string is centered at the top
  292.           of the graph.
  293.  
  294.      --ttff <<ffoonnttnnaammee>> ((TTiittlleeFFoonntt))
  295.           Title font.  This is the name of the font to use for
  296.           the graph title.  It defaults to 9x15.
  297.  
  298.      --ttkk ((TTiicckkss))
  299.           This option causes _x_g_r_a_p_h to draw tick marks rather
  300.           than full grid lines.  The -bb option is also useful
  301.           when viewing graphs with tick marks only.
  302.  
  303.      --xx <<uunniittnnaammee>>
  304.           This is the unit name for the X axis.  Its default is
  305.           "X".
  306.  
  307.      --yy <<uunniittnnaammee>>
  308.           This is the unit name for the Y axis.  Its default is
  309.           "Y".
  310.  
  311.      --zzgg <<ccoolloorr>> ((ZZeerrooCCoolloorr))
  312.           This is the color used to draw the zero grid line.
  313.  
  314.      Some options can only be specified in the X defaults file.
  315.      These options are described below:
  316.  
  317.      <<ddiiggiitt>>..CCoolloorr
  318.           Specifies the color for a data set.  Eight independent
  319.           colors can be specified.  Thus,  the digit should be
  320.           between '0' and '7'.  If there are more than eight data
  321.           sets,  the colors will repeat but with a new line style
  322.           (see below).
  323.  
  324.  
  325.  
  326.  
  327. Sprite v1.0             February 1, 1989                        5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. XGRAPH                    User Commands                    XGRAPH
  335.  
  336.  
  337.  
  338.      <<ddiiggiitt>>..SSttyyllee
  339.           Specifies the line style for a data set.  A sixteen-bit
  340.           integer specifies the sixteen-bit pattern used for the
  341.           line style.  Eight independent line styles can be
  342.           specified.  Thus,  the digit should be between '0' and
  343.           '7'.  If there are more than eight data sets,  these
  344.           styles will be reused.  On color workstations,  one
  345.           line style is used for each of eight colors.  Thus,  64
  346.           unique data sets can be displayed.
  347.  
  348.      GGrriiddSSiizzee
  349.           Width,  in pixels,  of normal grid lines.
  350.  
  351.      GGrriiddSSttyyllee
  352.           Line style pattern of normal grid lines.
  353.  
  354.      ZZeerrooSSiizzee
  355.           Width,  in pixels,  of the zero grid line.
  356.  
  357.      ZZeerrooSSttyyllee
  358.           Line style pattern of the zero grid line.
  359.  
  360. AAUUTTHHOORR
  361.      David Harrison University of California
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393. Sprite v1.0             February 1, 1989                        6
  394.  
  395.  
  396.  
  397.